Doc improvements for Garmin GPI and Unicsv per 'Proximity Alerts' thread.
authorRobert Lipe <robertlipe@gpsbabel.org>
Sun, 28 Feb 2016 23:16:28 +0000 (17:16 -0600)
committerRobert Lipe <robertlipe@gpsbabel.org>
Sun, 28 Feb 2016 23:16:28 +0000 (17:16 -0600)
xmldoc/formats/garmin_gpi.xml
xmldoc/formats/unicsv.xml

index 005e922025e37a5265cc58b6ab2f6e83746a46f7..5dae5f4ec549b96ec98ee416af21bacffc985e57 100644 (file)
    encrypted." means we could basically recognize it as a Garmin GPI file,
    but it's mangled beyond what we're likely to successfully read.
 </para>
+<para>
+  If a waypoint name is annotated with a trailing '@'NNN where NNN is 
+  a number, that number will be used as the speed for POI alerts, just
+  as with Garmin's POI Loader program. The units default to metric kilometers
+  per hour, but this cn be changed to statute via the units argument.
+  A speed associated with a specific POI will get precdence over any
+  'speed' argument provided. For example, a waypoint named "Point@30" will
+  associate a speed of 30 km/h with that specific point even if 'speed=40m'
+  is present in the output arguments.
+</para>
 <para>
    The layout of GPI files isn't documented and our module was created
    via reverse engineering. If you get a problem on reading or writing 
index 19a23819cc36862f969c9200ac2cab12cf517852..093619af4c380ee35abf2efd686f64417df5a4cf 100644 (file)
@@ -51,7 +51,7 @@
       power =    Cycling power (in Watts)
       prox =     Proximity (in meters).  Add "ft" or "feet" for feet.
       sat =      Number of sats used for fix
-      speed =    Speed
+      speed =    Speed, in meters per second.
       symb =     Symbol (icon) name
       tempf =    Temperature (degrees Fahrenheit)
       temp =     Temperature (degrees Celsius)